<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfdXmppServer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinfinity-0.4 Reference Manual">
<link rel="up" href="ch05.html" title="Libinfinity server side API">
<link rel="prev" href="InfdXmlServer.html" title="InfdXmlServer">
<link rel="next" href="InfdServerPool.html" title="InfdServerPool">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="InfdXmlServer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.4 Reference Manual</th>
<td><a accesskey="n" href="InfdServerPool.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfdXmppServer.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InfdXmppServer.description" class="shortcut">Description</a>
                   | 
                  <a href="#InfdXmppServer.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#InfdXmppServer.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#InfdXmppServer.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#InfdXmppServer.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="InfdXmppServer">
<a name="InfdXmppServer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfdXmppServer.top_of_page"></a>InfdXmppServer</span></h2>
<p>InfdXmppServer</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="InfdXmppServer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="InfdXmppServer.html#InfdXmppServer-struct" title="InfdXmppServer">InfdXmppServer</a>;
                    <a class="link" href="InfdXmppServer.html#InfdXmppServerClass" title="InfdXmppServerClass">InfdXmppServerClass</a>;
<a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="returnvalue">InfdXmppServer</span></a> *    <a class="link" href="InfdXmppServer.html#infd-xmpp-server-new" title="infd_xmpp_server_new ()">infd_xmpp_server_new</a>                (<em class="parameter"><code><a class="link" href="InfdTcpServer.html" title="InfdTcpServer"><span class="type">InfdTcpServer</span></a> *tcp</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> policy</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libinfinity-0.4-InfCertificateCredentials.html#InfCertificateCredentials" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a> *creds</code></em>,
                                                         <em class="parameter"><code><span class="type">Gsasl</span> *sasl_context</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sasl_mechanisms</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfdXmppServer.html#infd-xmpp-server-set-security-policy" title="infd_xmpp_server_set_security_policy ()">infd_xmpp_server_set_security_policy</a>
                                                        (<em class="parameter"><code><a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a> *server</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> policy</code></em>);
<a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="returnvalue">InfXmppConnectionSecurityPolicy</span></a>  <a class="link" href="InfdXmppServer.html#infd-xmpp-server-get-security-policy" title="infd_xmpp_server_get_security_policy ()">infd_xmpp_server_get_security_policy</a>
                                                        (<em class="parameter"><code><a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a> *server</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="InfdXmppServer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----InfdXmppServer
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="InfdXmppServer.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfdXmppServer implements
 <a class="link" href="InfdXmlServer.html" title="InfdXmlServer">InfdXmlServer</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="InfdXmppServer.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="InfdXmppServer.html#InfdXmppServer--credentials" title='The "credentials" property'>credentials</a>"              <a class="link" href="libinfinity-0.4-InfCertificateCredentials.html#InfCertificateCredentials" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a>*  : Read / Write / Construct
  "<a class="link" href="InfdXmppServer.html#InfdXmppServer--local-hostname" title='The "local-hostname" property'>local-hostname</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  "<a class="link" href="InfdXmppServer.html#InfdXmppServer--sasl-context" title='The "sasl-context" property'>sasl-context</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Read / Write / Construct
  "<a class="link" href="InfdXmppServer.html#InfdXmppServer--sasl-mechanisms" title='The "sasl-mechanisms" property'>sasl-mechanisms</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct
  "<a class="link" href="InfdXmppServer.html#InfdXmppServer--security-policy" title='The "security-policy" property'>security-policy</a>"          <a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a>  : Read / Write / Construct
  "<a class="link" href="InfdXmppServer.html#InfdXmppServer--tcp-server" title='The "tcp-server" property'>tcp-server</a>"               <a class="link" href="InfdTcpServer.html" title="InfdTcpServer"><span class="type">InfdTcpServer</span></a>*        : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="InfdXmppServer.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="InfdXmppServer.html#InfdXmppServer-error" title='The "error" signal'>error</a>"                                          : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="InfdXmppServer.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="InfdXmppServer.details"></a><h2>Details</h2>
<div class="refsect2" title="InfdXmppServer">
<a name="InfdXmppServer-struct"></a><h3>InfdXmppServer</h3>
<pre class="programlisting">typedef struct _InfdXmppServer InfdXmppServer;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="InfdXmppServerClass">
<a name="InfdXmppServerClass"></a><h3>InfdXmppServerClass</h3>
<pre class="programlisting">typedef struct {
  GObjectClass parent_class;

  /* Signals */
  void (*error)(InfdXmppServer* server,
                GError* error);
} InfdXmppServerClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="infd_xmpp_server_new ()">
<a name="infd-xmpp-server-new"></a><h3>infd_xmpp_server_new ()</h3>
<pre class="programlisting"><a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="returnvalue">InfdXmppServer</span></a> *    infd_xmpp_server_new                (<em class="parameter"><code><a class="link" href="InfdTcpServer.html" title="InfdTcpServer"><span class="type">InfdTcpServer</span></a> *tcp</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> policy</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libinfinity-0.4-InfCertificateCredentials.html#InfCertificateCredentials" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a> *creds</code></em>,
                                                         <em class="parameter"><code><span class="type">Gsasl</span> *sasl_context</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sasl_mechanisms</code></em>);</pre>
<p>
Creates a new <a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a> with <em class="parameter"><code>tcp</code></em> as underlaying TCP server object.
No attempt is being made to open <em class="parameter"><code>tcp</code></em>, if it is not already open. When a
new connection comes in, the XMPP server creates a XMPP connection that
may be used to communicate with the client. Note however that the
resulting connection will be in status OPENING until authentication has
completed.
</p>
<p>
If <em class="parameter"><code>policy</code></em> is <code class="literal">INF_XMPP_CONNECTION_SECURITY_ONLY_UNSECURED</code>, then <em class="parameter"><code>creds</code></em> may
be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. If <em class="parameter"><code>creds</code></em> is non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> nevertheless, then it is possible to change
the security policy later using <a class="link" href="InfdXmppServer.html#infd-xmpp-server-set-security-policy" title="infd_xmpp_server_set_security_policy ()"><code class="function">infd_xmpp_server_set_security_policy()</code></a>.
<em class="parameter"><code>creds</code></em> can also be changed later while the server is running. So just set
valid credentials before changing <em class="parameter"><code>policy</code></em> to allow TLS.
</p>
<p>
If <em class="parameter"><code>sasl_context</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the server uses a built-in context that only
supports ANONYMOUS authentication. If <em class="parameter"><code>sasl_context</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then
<em class="parameter"><code>sasl_mechanisms</code></em> specifies the mechanisms offered to clients. If
<em class="parameter"><code>sasl_mechanisms</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then all available mechanims will be offered.
If <em class="parameter"><code>sasl_context</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then this parameter is ignored.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tcp</code></em> :</span></p></td>
<td>A <a class="link" href="InfdTcpServer.html" title="InfdTcpServer"><span class="type">InfdTcpServer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy</code></em> :</span></p></td>
<td>The initial security policy.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>creds</code></em> :</span></p></td>
<td>Certificate credentials used to secure any communication.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sasl_context</code></em> :</span></p></td>
<td>A SASL context used for authentication.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sasl_mechanisms</code></em> :</span></p></td>
<td>A whitespace-sparated list of SASL mechanisms.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_xmpp_server_set_security_policy ()">
<a name="infd-xmpp-server-set-security-policy"></a><h3>infd_xmpp_server_set_security_policy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                infd_xmpp_server_set_security_policy
                                                        (<em class="parameter"><code><a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a> *server</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> policy</code></em>);</pre>
<p>
Sets the security policy for newly accepted <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>s.
Does not already established connections.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
<td>A <a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy</code></em> :</span></p></td>
<td>The new security policy.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infd_xmpp_server_get_security_policy ()">
<a name="infd-xmpp-server-get-security-policy"></a><h3>infd_xmpp_server_get_security_policy ()</h3>
<pre class="programlisting"><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="returnvalue">InfXmppConnectionSecurityPolicy</span></a>  infd_xmpp_server_get_security_policy
                                                        (<em class="parameter"><code><a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a> *server</code></em>);</pre>
<p>
Returns the current security policy for newly accepted
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>s.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
<td>A <a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The current security policy.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="InfdXmppServer.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "credentials" property'>
<a name="InfdXmppServer--credentials"></a><h3>The <code class="literal">"credentials"</code> property</h3>
<pre class="programlisting">  "credentials"              <a class="link" href="libinfinity-0.4-InfCertificateCredentials.html#InfCertificateCredentials" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a>*  : Read / Write / Construct</pre>
<p>The certificate credentials for GnuTLS.</p>
</div>
<hr>
<div class="refsect2" title='The "local-hostname" property'>
<a name="InfdXmppServer--local-hostname"></a><h3>The <code class="literal">"local-hostname"</code> property</h3>
<pre class="programlisting">  "local-hostname"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
<p>Hostname of the server.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "sasl-context" property'>
<a name="InfdXmppServer--sasl-context"></a><h3>The <code class="literal">"sasl-context"</code> property</h3>
<pre class="programlisting">  "sasl-context"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Read / Write / Construct</pre>
<p>The GnuSASL context used for authentaction.</p>
</div>
<hr>
<div class="refsect2" title='The "sasl-mechanisms" property'>
<a name="InfdXmppServer--sasl-mechanisms"></a><h3>The <code class="literal">"sasl-mechanisms"</code> property</h3>
<pre class="programlisting">  "sasl-mechanisms"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct</pre>
<p>The SASL mechanisms offered to the client for authentication.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "security-policy" property'>
<a name="InfdXmppServer--security-policy"></a><h3>The <code class="literal">"security-policy"</code> property</h3>
<pre class="programlisting">  "security-policy"          <a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a>  : Read / Write / Construct</pre>
<p>Whether to offer or require TLS.</p>
<p>Default value: INF_XMPP_CONNECTION_SECURITY_ONLY_UNSECURED</p>
</div>
<hr>
<div class="refsect2" title='The "tcp-server" property'>
<a name="InfdXmppServer--tcp-server"></a><h3>The <code class="literal">"tcp-server"</code> property</h3>
<pre class="programlisting">  "tcp-server"               <a class="link" href="InfdTcpServer.html" title="InfdTcpServer"><span class="type">InfdTcpServer</span></a>*        : Read / Write / Construct Only</pre>
<p>Underlaying TCP server.</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="InfdXmppServer.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "error" signal'>
<a name="InfdXmppServer-error"></a><h3>The <code class="literal">"error"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a> *infdxmppserver,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        arg1,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)           : Run Last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>infdxmppserver</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>